<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos  -->
			<title>Docs For Class Rho_DB_Driver</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
						<script src="../../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../../media/images/plus.png";
				imgMinus.src = "../../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle">Interface Rho_DB_Driver</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Interface for database drivers.</p>
		<p class="notes">
			Located in <a class="field" href="_rho---db---Rho_DB_Driver.inc.php.html">/rho/db/Rho_DB_Driver.inc.php</a> (line <span class="field">11</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																																							
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">int|bool</span>
										<a href="#affectedRows" title="details" class="method-name">affectedRows</a>
											(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#cleanString" title="details" class="method-name">cleanString</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$str</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#close" title="details" class="method-name">close</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#connect" title="details" class="method-name">connect</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#convertDate" title="details" class="method-name">convertDate</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$date</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#convertDateTime" title="details" class="method-name">convertDateTime</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$date</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#convertTime" title="details" class="method-name">convertTime</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$time</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$time</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#escapeDate" title="details" class="method-name">escapeDate</a>
											(<span class="var-type">&$date</span>&nbsp;<span class="var-name">&$date</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#escapeDateTime" title="details" class="method-name">escapeDateTime</a>
											(<span class="var-type">&$date</span>&nbsp;<span class="var-name">&$date</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#escapeField" title="details" class="method-name">escapeField</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$field</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$table</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#escapeString" title="details" class="method-name">escapeString</a>
											(<span class="var-type">&$str</span>&nbsp;<span class="var-name">&$str</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#escapeTable" title="details" class="method-name">escapeTable</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$table</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#escapeTime" title="details" class="method-name">escapeTime</a>
											(<span class="var-type">&$time</span>&nbsp;<span class="var-name">&$time</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result"><a href="../../Rho/Rho-database/DB_Record.html">DB_Record</a></span>
										<a href="#fetchObject" title="details" class="method-name">fetchObject</a>
											(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$record_class</span>, <span class="var-type"><a href="../../Rho/Rho-database/DB_Model.html">DB_Model</a></span>&nbsp;<span class="var-name">&$model</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#freeResult" title="details" class="method-name">freeResult</a>
											(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">resource|object|bool</span>
										<a href="#getLink" title="details" class="method-name">&amp;getLink</a>
										()
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">int|string</span>
										<a href="#lastInsertID" title="details" class="method-name">lastInsertID</a>
											(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#limit" title="details" class="method-name">limit</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$qty</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">NULL</span>])
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">int</span>
										<a href="#numRows" title="details" class="method-name">numRows</a>
											(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">resource|object|bool</span>
										<a href="#query" title="details" class="method-name">query</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$sql</span>)
									</div>
															
				<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#seek" title="details" class="method-name">seek</a>
											(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$row_number</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodaffectedRows" id="affectedRows"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">affectedRows</span> (line <span class="line-number">32</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the number of affected rows.</p>
<p class="description"><p>May well not be dependant on $resource - should be called imediately after query().  May require an active connection.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The number of affected rows (which may be 0) or FALSE if there's no connection.</li>
				<li><span class="field">throws:</span> DB_Connection_Exception If there's a connection error.</li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int|bool</span>
		<span class="method-name">
			affectedRows
		</span>
					(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">resource|object </span>
				<span class="var-name">&$resource</span><span class="var-description">: The result as returned by query()</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcleanString" id="cleanString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">cleanString</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cleans a string returned from the database.</p>
<p class="description"><p>Should reverse escapeString().</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodescapeString">Rho_DB_Driver::escapeString()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			cleanString
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$str</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$str</span><span class="var-description">: Note this is passed by reference, so the original variable will be altered.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">close</span> (line <span class="line-number">149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes the connection if connected.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			close
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodconnect" id="connect"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">connect</span> (line <span class="line-number">15</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Connects to the database.</p>
	<ul class="tags">
				<li><span class="field">throws:</span> DB_Connection_Exception If there's a connection error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			connect
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodconvertDate" id="convertDate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">convertDate</span> (line <span class="line-number">86</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a date from the database's native format to ISO 8601 format - Y-m-d  .</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodescapeDate">Rho_DB_Driver::escapeDate()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			convertDate
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$date</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$date</span><span class="var-description">: Note this is passed by reference, so the original variable will be altered.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodconvertDateTime" id="convertDateTime"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">convertDateTime</span> (line <span class="line-number">97</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a date-time from the database's native format to ISO 8601 format.</p>
	<ul class="tags">
				<li><span class="field">return:</span> in Y-m-d HH:MM:SS format.</li>
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodescapeDateTime">Rho_DB_Driver::escapeDateTime()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			convertDateTime
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$date</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$date</span><span class="var-description">: Note this is passed by reference, so the original variable will be altered.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodconvertTime" id="convertTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">convertTime</span> (line <span class="line-number">91</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a time from the database's native format to ISO 8601 format HH:MM:SS.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodescapeTime">Rho_DB_Driver::escapeTime()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			convertTime
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$time</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$time</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$time</span><span class="var-description">: Note this is passed by reference, so the original variable will be altered.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$time</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescapeDate" id="escapeDate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">escapeDate</span> (line <span class="line-number">113</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escape a date for use for the database, including adding quotes if needed.</p>
<p class="description"><p>Drivers must convert from the ISO 8601 format to the native format if required.  May require an active connection to the database server.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodconvertDate">Rho_DB_Driver::convertDate()</a></li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">throws:</span> DB_Connection_Exception If there's a connection error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			escapeDate
		</span>
					(<span class="var-type">&$date</span>&nbsp;<span class="var-name">&$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">&$date</span>
				<span class="var-name">&$date</span><span class="var-description">: The string to escape in Y-m-d format  Note this is passed by reference, so the original variable will be altered.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescapeDateTime" id="escapeDateTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">escapeDateTime</span> (line <span class="line-number">127</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escape a date for use for the database, including adding quotes if needed.</p>
<p class="description"><p>Drivers must convert from the ISO 8601 format to the native format if required.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodconvertDateTime">Rho_DB_Driver::convertDateTime()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			escapeDateTime
		</span>
					(<span class="var-type">&$date</span>&nbsp;<span class="var-name">&$date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">&$date</span>
				<span class="var-name">&$date</span><span class="var-description">: The string to escape in Y-m-d HH:MM:SS format.  Note this is passed by reference, so the original variable will be altered.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescapeField" id="escapeField"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">escapeField</span> (line <span class="line-number">133</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escapes a field name for use in the database</p>
	<ul class="tags">
				<li><span class="field">return:</span> The escaped field name, e.g. `widgets`.`name`</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			escapeField
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$field</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$table</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$field</span><span class="var-description">: The field name - may be *.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$table</span><span class="var-description">: The name of the field's table or an empty string.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescapeString" id="escapeString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">escapeString</span> (line <span class="line-number">103</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escape a string for use for the database, including adding quotes.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodcleanString">Rho_DB_Driver::cleanString()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			escapeString
		</span>
					(<span class="var-type">&$str</span>&nbsp;<span class="var-name">&$str</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">&$str</span>
				<span class="var-name">&$str</span><span class="var-description">: The string to escape.  Note this is passed by reference, so the original variable will be altered.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescapeTable" id="escapeTable"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">escapeTable</span> (line <span class="line-number">138</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escapes a table name for use in the database</p>
	<ul class="tags">
				<li><span class="field">return:</span> The escaped table name, e.g. `widgets`</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			escapeTable
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$table</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$table</span><span class="var-description">: The name of the table.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescapeTime" id="escapeTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">escapeTime</span> (line <span class="line-number">120</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Escape a time for use for the database, including adding quotes if needed.</p>
<p class="description"><p>Drivers must convert from the ISO 8601 format to the native format if required.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Rho/Rho-database/Rho_DB_Driver.html#methodconvertTime">Rho_DB_Driver::convertTime()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			escapeTime
		</span>
					(<span class="var-type">&$time</span>&nbsp;<span class="var-name">&$time</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">&$time</span>
				<span class="var-name">&$time</span><span class="var-description">: The string to escape in HH:MM:SS format.  Note this is passed by reference, so the original variable will be altered.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfetchObject" id="fetchObject"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">fetchObject</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return a row as an object.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Object or NULL.</li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../../Rho/Rho-database/DB_Record.html">DB_Record</a></span>
		<span class="method-name">
			fetchObject
		</span>
					(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$record_class</span>, <span class="var-type"><a href="../../Rho/Rho-database/DB_Model.html">DB_Model</a></span>&nbsp;<span class="var-name">&$model</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">resource|object </span>
				<span class="var-name">&$resource</span><span class="var-description">: The result as returned by query() with a SELECT statement.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$record_class</span><span class="var-description">: The name of Class of the object returned - normally 'DB_Record'.</span>			</li>
					<li>
				<span class="var-type"><a href="../../Rho/Rho-database/DB_Model.html">DB_Model</a></span>
				<span class="var-name">&$model</span><span class="var-description">: A model object responsible for the row object,  passed as a parameter to the record class constructor, or NULL when no model is being used.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfreeResult" id="freeResult"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">freeResult</span> (line <span class="line-number">38</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Frees a result.</p>
<p class="description"><p>Should not throw an exception</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE on success.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			freeResult
		</span>
					(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">resource|object </span>
				<span class="var-name">&$resource</span><span class="var-description">: The result as returned by query()</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetLink" id="getLink"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">getLink</span> (line <span class="line-number">65</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the link to the server if connected.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The link, or FALSE if connection failed, or NULL if not currently connected.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">resource|object|bool</span>
		<span class="method-name">
			&amp;getLink
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlastInsertID" id="lastInsertID"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">lastInsertID</span> (line <span class="line-number">74</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the last insert id after an INSERT on a table with an autoincrementing primary key.</p>
<p class="description"><p>May well not be dependant on $resource - should be called imediately after query().  May require an active connection.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The last insert id.</li>
				<li><span class="field">throws:</span> DB_Connection_Exception If there's a connection error.</li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int|string</span>
		<span class="method-name">
			lastInsertID
		</span>
					(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">resource|object </span>
				<span class="var-name">&$resource</span><span class="var-description">: The result as returned by query() with a SELECT statement.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlimit" id="limit"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">limit</span> (line <span class="line-number">145</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Produces a LIMIT snippet for use in an SQL query.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The limit statement, inluding the keyword. e.g. ' LIMIT 20,10 '</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			limit
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$qty</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$qty</span><span class="var-description">: The maximum number of records the fetch inclusive.</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$offset</span><span class="var-description">: The row number of the first record to fetch from where the first row is 0.  Driver must compansate internally if this is not the case.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnumRows" id="numRows"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">numRows</span> (line <span class="line-number">44</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return number of rows of a SELECT query result.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The number of affected rows (which may be 0).</li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			numRows
		</span>
					(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">resource|object </span>
				<span class="var-name">&$resource</span><span class="var-description">: The result as returned by query() with a SELECT statement.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodquery" id="query"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">query</span> (line <span class="line-number">23</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Executes a SQL statement.</p>
<p class="description"><p>Will attempt to connect if not already connected to the server.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The result of the query or FALSE</li>
				<li><span class="field">throws:</span> DB_Connection_Exception If there's a connection error.</li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">resource|object|bool</span>
		<span class="method-name">
			query
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$sql</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$sql</span>			</li>
				</ul>
		
			
	</div>
<a name="methodseek" id="seek"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">seek</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Move the database pointer.</p>
<p class="description"><p>This assumes that the first row is 0 - the driver must compansate internally if this is not the case.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE on success</li>
				<li><span class="field">throws:</span> Rho_Exception if there's a database error.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			seek
		</span>
					(<span class="var-type">resource|object </span>&nbsp;<span class="var-name">&$resource</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$row_number</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">resource|object </span>
				<span class="var-name">&$resource</span><span class="var-description">: The result as returned by query() with a SELECT statement.</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$row_number</span><span class="var-description">: The row number to seek to, where 0 is the first row.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Tue, 13 Oct 2009 19:17:25 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>